Interface RouterPort

All Superinterfaces:
HostPort, IPCObject, Port, Process
All Known Subinterfaces:
FRSubInterface, RoutedSwitchPort, VirtualTemplateInterface
All Known Implementing Classes:
FRSubInterfaceImpl, RoutedSwitchPortImpl, RouterPortImpl, VirtualTemplateInterfaceImpl

public interface RouterPort extends HostPort
Information provided by the PKI file:

    \class RouterPort
    
    \brief RouterPort handles and manipulates the router port.
    
    \example network().getDevice("Router0").getPort("FastEthernet0/0")
    
Author:
Auto-generated
  • Method Details

    • setAclInID

      void setAclInID(String aclId)
      Information provided by the PKI file:
      
          \brief Sets an inbound ACL.
          
          \param aclId, the ID of the ACL.
          
              
      Parameters:
      aclId - Takes in a parameter of aclId
    • setAclOutID

      void setAclOutID(String aclId)
      Information provided by the PKI file:
      
          \brief Sets an outbound ACL.
          
          \param aclId, the ID of the ACL.
          
              
      Parameters:
      aclId - Takes in a parameter of aclId
    • getAclInID

      String getAclInID()
      Information provided by the PKI file:
      
          \brief Returns the inbound ACL ID.
          
          \param string, the ID of the inbound ACL.
          
              
      Returns:
      String Returns a String
    • getAclOutID

      String getAclOutID()
      Information provided by the PKI file:
      
          \brief Returns the outbound ACL ID.
          
          \param string, the ID of the outbound ACL.
          
              
      Returns:
      String Returns a String
    • setNatMode

      void setNatMode(NATMode type)
      Information provided by the PKI file:
      
          \brief Sets the NAT mode.
          
          \param type,        the NAT mode.
          NAT modes:  eNatNull = 0,
          eNatInside = 1,
          eNatOutside = 2
          
              
      Parameters:
      type - Takes in a parameter of type
    • getNatMode

      NATMode getNatMode()
      Information provided by the PKI file:
      
          \brief Returns the NAT mode.
          
          \param NatMode,     the NAT mode.
          NAT modes:  eNatNull = 0,
          eNatInside = 1,
          eNatOutside = 2
          
              
      Returns:
      NATMode Returns a NATMode
    • setCdpEnable

      void setCdpEnable(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables CDP.
          
          \param bEnable, true to enable CDP, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • isCdpEnable

      boolean isCdpEnable()
      Information provided by the PKI file:
      
          \brief Returns true if CDP is enabled, otherwise false.
          
          \return bool, true if CDP is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setRipPassive

      void setRipPassive(boolean bRipPassive)
      Information provided by the PKI file:
      
          \brief Enables or disables RIP passive interface.
          
          \param bRipPassive, true to enable RIP passive interface, false to disable it.
          
              
      Parameters:
      bRipPassive - Takes in a parameter of bRipPassive
    • isRipPassive

      boolean isRipPassive()
      Information provided by the PKI file:
      
          \brief Returns true if RIP passive interface is enabled, otherwise false.
          
          \return bool, true if RIP passive interface is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setRipSplitHorizon

      void setRipSplitHorizon(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables RIP split horizon.
          
          \param bEnable, true to enable RIP split horizon, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • isRipSplitHorizon

      boolean isRipSplitHorizon()
      Information provided by the PKI file:
      
          \brief Returns true if RIP split horizon is enabled, otherwise false.
          
          \return bool, true if RIP split horizon is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • addEntryEigrpPassive

      void addEntryEigrpPassive(int as, boolean bPassive)
      Information provided by the PKI file:
      
          \brief Enables or disables EIGRP passive interface for the specified AS.
          
          \param as, the EIGRP AS number.
          \param bPassive, true to enable EIGRP passive interface, false to disable it.
          
              
      Parameters:
      as - Takes in a parameter of as
      bPassive - Takes in a parameter of bPassive
    • removeEntryEigrpPassive

      void removeEntryEigrpPassive(int as)
      Information provided by the PKI file:
      
          \brief Remvoes EIGRP passive interface for the specified AS.
          
          \param as, the EIGRP AS number of interest.
          
              
      Parameters:
      as - Takes in a parameter of as
    • getOspfAuthType

      int getOspfAuthType()
      Information provided by the PKI file:
      
          \brief Returns the OSPF authentication type.
          
          \return int, the OSPF authentication type.
          
              
      Returns:
      int Returns a int
    • setOspfAuthKey

      void setOspfAuthKey(String key)
      Information provided by the PKI file:
      
          \brief Sets the OSPF authentication key.
          
          \param key, the OSPF authentication key.
          
              
      Parameters:
      key - Takes in a parameter of key
    • getOspfAuthKey

      String getOspfAuthKey()
      Information provided by the PKI file:
      
          \brief Returns the OSPF authentication key.
          
          \param string, the OSPF authentication key.
          
              
      Returns:
      String Returns a String
    • addOspfMd5Key

      boolean addOspfMd5Key(Short keyId, String key)
      Information provided by the PKI file:
      
          \brief Adds an OSPF MD5 key.
          
          \param keyId, the key ID.
          \param key, the key.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      keyId - Takes in a parameter of keyId
      key - Takes in a parameter of key
      Returns:
      boolean Returns a boolean
    • removeOspfMd5Key

      void removeOspfMd5Key(Short keyId)
      Information provided by the PKI file:
      
          \brief Removes the specified OSPF MD5 key.
          
          \param keyId, the key ID.
          
              
      Parameters:
      keyId - Takes in a parameter of keyId
    • setOspfCost

      void setOspfCost(Short cost)
      Information provided by the PKI file:
      
          \brief Sets the OSPF cost.
          
          \param cost, the cost value.
          
              
      Parameters:
      cost - Takes in a parameter of cost
    • getOspfCost

      Short getOspfCost()
      Information provided by the PKI file:
      
          \brief Returns the OSPF cost.
          
          \return short, the cost value.
          
              
      Returns:
      Short Returns a Short
    • setOspfDeadInterval

      void setOspfDeadInterval(Short interval)
      Information provided by the PKI file:
      
          \brief Sets the OSPF dead interval.
          
          \param interval, the OSPF dead interval value.
          
              
      Parameters:
      interval - Takes in a parameter of interval
    • getOspfDeadInterval

      Short getOspfDeadInterval()
      Information provided by the PKI file:
      
          \brief Returns the OSPF dead interval.
          
          \return short, the OSPF dead interval value.
          
              
      Returns:
      Short Returns a Short
    • setOspfHelloInterval

      void setOspfHelloInterval(Short interval)
      Information provided by the PKI file:
      
          \brief Sets the OSPF hello interval.
          
          \param interval, the OSPF hello interval value.
          
              
      Parameters:
      interval - Takes in a parameter of interval
    • getOspfHelloInterval

      Short getOspfHelloInterval()
      Information provided by the PKI file:
      
          \brief Returns the OSPF hello interval.
          
          \return short, the OSPF hello interval value.
          
              
      Returns:
      Short Returns a Short
    • setOspfPriority

      void setOspfPriority(Short usPriority)
      Information provided by the PKI file:
      
          \brief Sets the OSPF priority.
          
          \param usPriority, the OSPF priority value.
          
              
      Parameters:
      usPriority - Takes in a parameter of usPriority
    • getOspfPriority

      Short getOspfPriority()
      Information provided by the PKI file:
      
          \brief Returns the OSPF priority.
          
          \return short, the OSPF priority value.
          
              
      Returns:
      Short Returns a Short
    • setDelay

      void setDelay(int delay)
      Information provided by the PKI file:
      
          \brief Sets the delay.
          
          \param delay, the delay value.
          
              
      Parameters:
      delay - Takes in a parameter of delay
    • getDelay

      int getDelay()
      Information provided by the PKI file:
      
          \brief Returns the delay.
          
          \return delay, the delay value.
          
              
      Returns:
      int Returns a int
    • setBandwidthInfo

      void setBandwidthInfo(int bandwidth)
      Information provided by the PKI file:
      
          \brief Sets the bandwidth.
          
          \param bandwidth, the bandwidth value.
          
              
      Parameters:
      bandwidth - Takes in a parameter of bandwidth
    • getBandwidthInfo

      int getBandwidthInfo()
      Information provided by the PKI file:
      
          \brief Returns the bandwidth.
          
          \return int, the bandwidth value.
          
              
      Returns:
      int Returns a int
    • resetBandwidth

      void resetBandwidth()
      Information provided by the PKI file:
      
          \brief Resets the bandwidth.
          
              
    • resetDelay

      void resetDelay()
      Information provided by the PKI file:
      
          \brief Resets the delay.
          
              
    • setIntForAs

      void setIntForAs(Short as, Short interval)
      Information provided by the PKI file:
      
          \brief Sets the interval for the specified EIGRP AS.
          
          \param as, the EIGRP AS of interest.
          \param interval, the interval value.
          
              
      Parameters:
      as - Takes in a parameter of as
      interval - Takes in a parameter of interval
    • getIntOfAs

      Short getIntOfAs(Short as)
      Information provided by the PKI file:
      
          \brief Returns the interval for the specified EIGRP AS.
          
          \param as, the EIGRP AS of interest.
          
          \return short, the interval for the specified EIGRP AS.
          
              
      Parameters:
      as - Takes in a parameter of as
      Returns:
      Short Returns a Short
    • addSummaryAddress

      boolean addSummaryAddress(Short as, IPAddress networkAddress, IPAddress mask, int adminDistance)
      Information provided by the PKI file:
      
          \brief Adds a summary address for the specified EIGRP AS.
          
          \param as, the EIGRP AS of interest.
          \param networkAddress, the network address.
          \param mask, the network mask.
          \param adminDistance, the administrative distance value.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      as - Takes in a parameter of as
      networkAddress - Takes in a parameter of networkAddress
      mask - Takes in a parameter of mask
      adminDistance - Takes in a parameter of adminDistance
      Returns:
      boolean Returns a boolean
    • removeSummaryAddress

      boolean removeSummaryAddress(Short as, IPAddress networkAddress, IPAddress mask, int adminDistance)
      Information provided by the PKI file:
      
          \brief Removes the summary address for the specified EIGRP AS.
          
          \param as, the EIGRP AS of interest.
          \param networkAddress, the network address.
          \param mask, the network mask.
          \param adminDistance, the administrative distance value.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      as - Takes in a parameter of as
      networkAddress - Takes in a parameter of networkAddress
      mask - Takes in a parameter of mask
      adminDistance - Takes in a parameter of adminDistance
      Returns:
      boolean Returns a boolean
    • getZoneMemberName

      String getZoneMemberName()
      Information provided by the PKI file:
      
          \brief Returns the zone name in which this port belongs.
          
          \return string, the zone name in which this port belongs.
          
              
      Returns:
      String Returns a String
    • setZoneMemberName

      void setZoneMemberName(String name)
      Information provided by the PKI file:
      
          \brief Sets the zone name for this port.
          
          \param name, the zone name for this port.
          
              
      Parameters:
      name - Takes in a parameter of name
    • setIpsInID

      void setIpsInID(String name)
      Information provided by the PKI file:
      
          \brief Sets the IPS as inside ID for this port.
          
          \param name, the name of the IPS.
          
              
      Parameters:
      name - Takes in a parameter of name
    • setIpsOutID

      void setIpsOutID(String name)
      Information provided by the PKI file:
      
          \brief Sets the IPS as outside ID for this port.
          
          \param name, the name of the IPS.
          
              
      Parameters:
      name - Takes in a parameter of name
    • getIpsInID

      String getIpsInID()
      Information provided by the PKI file:
      
          \brief Returns the IPS inside ID.
          
          \return string, the name of the IPS.
          
              
      Returns:
      String Returns a String
    • getIpsOutID

      String getIpsOutID()
      Information provided by the PKI file:
      
          \brief Returns the ips outside ID.
          
          \return string, the name of the IPS.
          
              
      Returns:
      String Returns a String
    • setProxyArpEnabled

      void setProxyArpEnabled(boolean enabled)
      Information provided by the PKI file:
      
          \brief Enables or disables proxy ARP.
          
          \param enabled, true to enable proxy ARP, false to disable it.
          
              
      Parameters:
      enabled - Takes in a parameter of enabled
    • isProxyArpEnabled

      boolean isProxyArpEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if proxy ARP is enabled, otherwise false.
          
          \return bool, true if proxy ARP is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isIkeEnabled

      boolean isIkeEnabled()
      Information provided by the PKI file:
      
          \brief Check is Ike is enabled on the port
          
          \return bool, true if it is enabled and false otherwise.
          
              
      Returns:
      boolean Returns a boolean
    • setIkeEnabled

      void setIkeEnabled(boolean flag)
      Information provided by the PKI file:
      
          \brief Enable or disable Ike on the port
          
          \param flag, true to enable and false otherwise.
          
              
      Parameters:
      flag - Takes in a parameter of flag